Neurosis Engine
Classes | Public Member Functions | Private Attributes
CNeurosisAudio Class Reference

Note: iChannel = [0..totalChannels-1]. More...

#include <audio.h>

List of all members.

Classes

class  CAudioData

Public Member Functions

 CNeurosisAudio (int totalChannels=4)
 ~CNeurosisAudio ()
 Constructor/Deconstructor.
void Clear (int iChannel)
 Clear memory.
int Get_State (int iChannel)
 Either AL_PLAYING, AL_PAUSED, or AL_STOPPED.
bool Is_Initialized ()
 Check if OpenAL initialized properly (i.e. total channels > 0)
bool Load (int iChannel, char *filename, bool stream)
 Load *.ogg audio file.
void Loop (int iChannel, bool loopAudio)
 Whether to loop audio (only streamed audio)
void Play (int iChannel)
 Play.
void Pause (int iChannel)
 Pause.
void Stop (int iChannel)
 Stop.
void Volume (int iChannel, float volumeAmount)
 Set volume [0.0f..1.0f].
void Update ()
 Update all channels.

Private Attributes

CAudioDatapAudio
int mTotalChannels

Detailed Description

Note: iChannel = [0..totalChannels-1].


Constructor & Destructor Documentation

CNeurosisAudio::CNeurosisAudio ( int  totalChannels = 4)

Constructor/Deconstructor.


Member Function Documentation

void CNeurosisAudio::Clear ( int  iChannel)

Clear memory.

int CNeurosisAudio::Get_State ( int  iChannel)

Either AL_PLAYING, AL_PAUSED, or AL_STOPPED.

Check if OpenAL initialized properly (i.e. total channels > 0)

bool CNeurosisAudio::Load ( int  iChannel,
char *  filename,
bool  stream 
)

Load *.ogg audio file.

void CNeurosisAudio::Loop ( int  iChannel,
bool  loopAudio 
)

Whether to loop audio (only streamed audio)

void CNeurosisAudio::Pause ( int  iChannel)

Pause.

void CNeurosisAudio::Play ( int  iChannel)

Play.

void CNeurosisAudio::Stop ( int  iChannel)

Stop.

Update all channels.

void CNeurosisAudio::Volume ( int  iChannel,
float  volumeAmount 
)

Set volume [0.0f..1.0f].


Member Data Documentation


The documentation for this class was generated from the following file: